home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / system / alarm400.zip / ALARM.DOC < prev    next >
Text File  |  1987-10-11  |  22KB  |  471 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                    ALARM : Alarm Clock Program and Utilities
  7.                            Version 4.00, 11-Oct-1987
  8.                                   SMG Software
  9.  
  10.                            (C) Copyright 1986,1987 by
  11.                                Steven Georgiades
  12.                               All Rights Reserved
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.                                Table of Contents
  27.                                -----------------
  28.  
  29.               I.    Overview  ...........................  Page 2
  30.  
  31.               II.   Program Installation and Usage  .....  Page 3
  32.  
  33.               III.  The ALARM Configuration File  .......  Page 5
  34.  
  35.               IV.   Revision History  ...................  Page 6
  36.  
  37.               V.    Additional Utilities  ...............  Page 7
  38.  
  39.               VI.   Program Restrictions  ...............  Page 7
  40.  
  41.               VII.  Program License  ....................  Page 8
  42.  
  43.               VIII. Program Registration  ...............  Page 8
  44.  
  45.               IX.   Disclaimer  .........................  Page 9
  46.  
  47.               X.    Reporting Problems  .................  Page 9
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.                                        1
  59.  
  60.     ALARM, Version 4.00                                              Page 2
  61.  
  62.  
  63.  
  64.  
  65.     I. OVERVIEW
  66.  
  67.          The  ALARM  program  provides a memory resident alarm  clock  with 
  68.     eight  different  alarms,   each  of which can be set to go  off  at  a 
  69.     different  time  of  day.   This is useful to signal the user  about  a 
  70.     meeting,   a   lunch date,  or an appointment.   ALARM  also  has  four 
  71.     reminders,   which  can be set to go off at different  time  intervals.  
  72.     These are useful for reminding the user to perform periodic tasks, such 
  73.     as doing saves while editing,  or taking medication.  Each of the eight 
  74.     alarms  and four reminders may have a user-defined  message  associated 
  75.     with it, up to 32 characters in length.  When the alarm time is reached 
  76.     (or  when  the reminder interval has expired),  the computer's  current 
  77.     activity  will be suspended,  and a window will appear in the middle of 
  78.     the  screen indicating the alarm or reminder number,  the current time, 
  79.     and  the corresponding message.   In addition,  a  musical tune will be 
  80.     played,   as  specified in the alarm configuration  file.    Using  the 
  81.     supplied tune-files and configuration file (ALARM.CFG),  these tunes 
  82.     will be as follows: 
  83.  
  84.  
  85.               Alarm #1 : Funeral March of the Marionettes 
  86.               Alarm #2 : Carnival
  87.               Alarm #3 : Holiday Road
  88.               Alarm #4 : When The Saints Go Marching In
  89.               Alarm #5 : Fur Elise
  90.               Alarm #6 : O' Solo Mio
  91.               Alarm #7 : Turkey in the Straw
  92.               Alarm #8 : Aura Lee
  93.            Reminder #1 : Oh! Susanna
  94.            Reminder #2 : London Bridge
  95.            Reminder #3 : Mary had a Little Lamb
  96.            Reminder #4 : Yankee Doodle
  97.  
  98.  
  99.     Note that upon installation,  the message associated with each alarm or 
  100.     reminder is set to the title of the corresponding tune.   In all cases, 
  101.     a  tune can be terminated before completion by pressing the Escape key.  
  102.     Once  an  alarm  or reminder has sounded,  the  window  will  disappear 
  103.     immediately, unless it was set to persist. In this case the window will 
  104.     remain (persist)  on the screen until the Escape key is pressed.   If a 
  105.     second  alarm time should be reached before the Escape key is  pressed, 
  106.     that alarm will supersede the first, and the first one will be aborted.  
  107.          In  addition to alarms and reminders,  the ALARM program also  has 
  108.     Westminster chimes which can be enabled to sound on the hour, half-hour 
  109.     or quarter-hour.  The chimes can also be disabled.  
  110.          A   facility  is  also  included  to  disable  the  ALARM  program 
  111.     completely.    This  is  useful when executing programs  which  may  be 
  112.     adversely  affected  by  a  pop-up window,   such  as  FORMAT  or  disk 
  113.     optimizing software.  
  114.  
  115.     ALARM, Version 4.00                                              Page 3
  116.  
  117.  
  118.  
  119.  
  120.     II. PROGRAM INSTALLATION AND USAGE
  121.  
  122.          In order for the ALARM program to work, it must first be installed 
  123.     as  resident in memory.   This is accomplished by one of the  following 
  124.     commands: 
  125.  
  126.          ALARM I             or             ALARM Ifilename.ext
  127.  
  128.     The first form will look for the default configuration file, ALARM.CFG, 
  129.     in  the  current  directory.    If  not  found,   ALARM  will  use   no 
  130.     configuration  data  and will install a very simple (and  very  boring) 
  131.     form of the program,  with "beeps"  instead of tunes.   The second form 
  132.     will look for the specified configuration file.  If not found, an error 
  133.     will be flagged.  Note that the filename may optionally include a drive 
  134.     letter and/or a path specification.   For more information on the ALARM 
  135.     configuration file, see section III, below. 
  136.  
  137.          Once installed in memory, three sub-systems are available: Alarms, 
  138.     Reminders, and Chimes.  The Alarms Sub-System consists of eight alarms, 
  139.     which may be set by issuing one of the following commands: 
  140.  
  141.          ALARM An=hh:mm          or           ALARM An=hh:mm/"msg"
  142.  
  143.          ALARM An=*hh:mm         or           ALARM An=*hh:mm/"msg"
  144.  
  145.     where "n"  is the alarm number (1 to 8), "hh:mm" is the alarm time,  in 
  146.     24-hour  format (5:00 pm  is 17:00),  and "msg"  is an  optional  alarm 
  147.     message  which  may be up to 32  characters in length.   If  "msg"   is 
  148.     omitted,  as in the left column above,  then the alarm message  remains 
  149.     unchanged.   If an asterisk ("*") is specified with the alarm time,  as 
  150.     in the bottom row above, then that alarm is set to persist.  Individual 
  151.     alarms may be enabled, disabled, queried, and tested, respectively,  by 
  152.     entering the following commands: 
  153.  
  154.          ALARM An+      ALARM An-      ALARM An?      ALARM AnT
  155.  
  156.     Disabling an alarm will not change it's setting.  When it is once again 
  157.     enabled,   it  will  still  be set to the same time as  before  it  was 
  158.     disabled.  Note that the act of setting an alarm enables it.  The query 
  159.     option  will  list the alarm number,  the current setting  (or  OFF  if 
  160.     disabled), and the current message associated with that alarm.  Testing 
  161.     an  alarm  will  cause an alarm window to pop up and  the  tune  to  be 
  162.     played,   just as if the alarm time had been reached.   This will  work 
  163.     regardless of whether the specified alarm is enabled.  
  164.          In addition to this,  the entire Alarms Sub-System may be enabled, 
  165.     disabled, or queried, as follows: 
  166.  
  167.          ALARM A+               ALARM A-               ALARM A?
  168.  
  169.     Disabling the Alarms Sub-System will disable all eight alarms.  This is 
  170.     different from disabling all eight alarms individually, since disabling 
  171.     and re-enabling the Alarms Sub-System will preserve the  enable/disable 
  172.     status of each alarm.   Querying the Alarms Sub-System is equivalent to 
  173.     querying each of the eight alarms individually.  
  174.  
  175.     ALARM, Version 4.00                                              Page 4
  176.  
  177.  
  178.  
  179.  
  180.     II. PROGRAM INSTALLATION AND USAGE (Continued)
  181.  
  182.          The  Reminders Sub-System behaves virtually the same as the Alarms 
  183.     Sub-System,   the only major difference being that a Reminder  Interval 
  184.     ("mm")   must be specified,  instead of an Alarm Time ("hh:mm").    The 
  185.     reminder interval may be from 1 to 255  minutes.   Note that there  are 
  186.     only  4  reminders,  so "n"  must be in the range 1 to 4.    To  set  a 
  187.     reminder, use the following commands: 
  188.  
  189.          ALARM Rn=mm             or           ALARM Rn=mm/"msg"
  190.  
  191.          ALARM Rn=*mm            or           ALARM Rn=*mm/"msg"
  192.  
  193.     To  enable,   disable,  query or test individual  reminders,   use  the 
  194.     following commands: 
  195.  
  196.          ALARM Rn+      ALARM Rn-      ALARM Rn?      ALARM RnT
  197.  
  198.     To enable,  disable